BuildManagerAPI Methods

An object defining methods for the BuildManagerAPI class.

SetUrl(url)

Sets the API URL for requests.

Parameters:

url (required): string
The new API URL.

Returns:

Type: void
Method does not return anything

Exceptions:

Type: ArgumentNullException
Throws ArgumentNullException if URL is null or empty.

Type: Exception
Throws Exception if the URL is invalid.

This is a sync method. Method runs synchronously.

---

GetDeployAgents(telemetryCollectorHolder)

Retrieves a list of deployment agents from the build manager, returning information about available agents in the response.

Parameters:

telemetryCollectorHolder (optional): ITelemetryCollectorHolder
Holds telemetry collection data for tracking and diagnostics during the retrieval process. Defaults to null if not provided, used for advanced telemetry purposes.

Returns:

Type: Task<WrapResponse<GetDeployAgentsResponse>>
Returns a wrapped response containing deployment agents.

This is a async method. Method should be waited. Be careful if call this method without waiting.

See Also

• Async/Await Usage